Shareware Grab Bag

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Grab Bag / Shareware Grab Bag.iso / 096 / proana.arc / PROANA.DOC next >

Wrap

Text File | 1985-10-25 | 31.4 KB | 925 lines

RBBS SYSOPS, DO YOU REALLY KNOW HOW MUCH USAGE YOUR SYSTEM GETS? THE PROFESSIONAL ANALYZER KNOW! Version 12.5B now available Version 13.1A Coming Soon See the last page for ordering information Be watching for a demo version of The Professional Analyzer in November on better BBS systems everywhere. The PROFESSIONAL ANALYZER system is an extension to the RBBS-PC software. It provides additional facilities for the analysis and maintenance of RBBS system and control files. Specifically, the Professional Analyzer provides the following facilities: 1. Analysis of the RBBS CALLERS file to provide the following: a. CALLERS file statistics b. A graph of call distribution by hour of the day c. A graph of number of calls by baud rate and parity setting d. A graph comparing upload activity to download activity e. A graph showing upload activity f. A graph showing download activity 2. Analysis of the RBBS MESSAGES file to provide the following: a. Bytes allocated to messages, bytes used and bytes available b. Total number of active, killed and blank messages c. Total number of public, receiver only (private), kill protected and password protected messages d. Maximum number of messages slots e. Average size of messages in both records and bytes f. Percentage of MESSAGES file currently available 3. Analysis of the USERS file by State in which each user resides 4. A full function field editor for editing any field in a users profile record found in the USERS file 5. Facilities for producing statistical reports for use as RBBS bulletins or printed reports CHAPTER 2 INSTALLATION Installation of the Professional Analyzer is very simple. The software is distributed on a DS/DD 360KB diskette. This diskette should be placed in diskette drive A. The DOS prompt should be sitting on the A drive, the +disk to which the system will be installed should be either another diskette or a hard disk. It is simplest to install the Professional Analyzer on the same drive and subdirectory as the RBBS system files that will be analyzed. Once the above setup has been achieved, enter the following to the DOS prompt: A:\>INSTALL C:\RBBS (where C: is the disk drive and \RBBS is the sub-directory to which you wish to install the software) The system will then begin installing. Wait until you see the message, "PROANA install completed". Once you receive this message the system is now installed. Put away the original diskette for safe keeping and backup purposes. The Professional Analyzer is not copy protected although it does carry with it an identification module named PROANA.UID. The integrity of this file must be preserved. If this file is not present or is in some way damaged or tampered with, the programs will not run. This file contains the users name and serial number, NOTE: All Professional Analyzer distribution modules/files are assumed to reside on the default drive and the current sub-directory during execution. Therefore care should be taken to insure that these files remain together in your system and that Professional Analyzer is executed only from this sub-directory. You are now ready to begin enjoying your new software! CHAPTER 3 USING THE PROFESSIONAL ANALYZER GETTING STARTED: At the DOS prompt enter PROANA C:\>PROANA If this is the first time you have executed the Professional Analyzer since installing it, you will automatically be taken to the configuration menu screen. If you have already run the program before and are just reviewing this documentation you may skip to the next section following CONFIGURING THE SYSTEM entitled THE MAIN MENU. If not, the system will respond with the message "PROANA Configuration file not found, one will be created". You will then be presented with a new screen. This screen should be used to customize the system to your specific installation. CONFIGURING THE SYSTEM: The configuration screen will present you with 9 options which you may or may not need to change. The program has a set of default parameters already specified You may used these defaults or you may change them to your needs. A discussion of each option follows. You may skip from field to field by using the up and down cursor keys found on the numeric key pad. o COLOR or MONOCHROME monitor (M or C) This field simply asks if you are using a color or monochrome monitor. You should enter an M for monochrome or a C for color. Monochrome is the default and might also be advisable for those users who are using a color board with a composite signal monochrome monitor. If available, the Professional Analyzer will make full use of the color capability of the PC. o RBBS callers file name o RBBS messages file name o RBBS users file name o RBBS DEF file name These fields specify the name of your RBBS system files. The standard names for these files are defaults. If yours have not been renamed in the RBBS Configuration program, then you may need to change these fields from their default value. If your system doesn't match these defaults then your specific configuration must be specified in these 4 fields. These fields can contain up to 21 characters. Any valid DOS file specification which is 21 characters or less is acceptable. The Professional Analyzer provide DOS device and path specification support. The following would all be valid entries: C:\RBBS\CALLERS A:\USERS A:USERS C:\RBBS\SUB1\MESSAGES MESSAGES \BBS\USERS o Statistics output file specification This field specifies the DOS file specification for routing Professional Analyzer hard copy statistics out of the system. The default is PROCALL.RPT. This can be renamed to any valid DOS file specification. If you wish to route the report to a hard copy printer you would specify its file spec, such as LPT1: or LPT2:. Many SYSOPs prefer to create RBBS bulletins from this report. This allows the RBBS system users to also see the statistics of the systems utilization. In this case you might want to specify this field as BULLETx, where x is the bulletin number you wish to uses on the RBBS system for this purpose. o Beginning date range (MMDDYY) o Ending date range (MMDDYY) The Professional Analyzer allow the user to limit the analysis of a callers file to certain date ranges within the callers file. If you wish to analyze only a certain date or a certain group of dates this parameter can be changed for the beginning and ending dates for which you wish to limit your analysis. o Logo delay time (in seconds) Once the Professional Analyzer has been completely installed and configured, each subsequent run of the system will begin with a graphics display logo. The amount of time the system keeps this logo on your screen can be regulated here. Initially, it has been set to 9 seconds. You can decrease or increase this time period from 1 to 9 seconds for all future executions of the system. You are now finished with the configuration menu. Remember this menu, as you may need to return here in the future to change some parameters. You will never be automatically returned here again unless your PROANA.CNF file gets deleted. To save the configuration hit the ESC key. The system will ask if you wish to save the configuration file. If you are happy with it now, then reply Y. If you reply N, then you will have to return back to this menu again and reconfigure the system. The Professional Analyzer cannot properly execute without the creation of a configuration file. THE MAIN MENU: Once the configuration process has been completed and saved, you will be returned to the logo screen and then to the Main Menu screen. The Main Menu is the screen from which all Professional Analyzer functions are selected. These functions are selected by entering the proper function key associated with each function. F1 selects the configuration program, F2 selects the callers analysis program, F3 selects the message file analysis program , F4 selects the user file analysis program and F5 selects the user file editor. No attempt will be made to explain in detail the function of these programs. However, a brief description follows along with a few notes to help make your use of these functions more efficient. The function of each program should be self evident. Note the function key and control key definitions at the bottom of each screen. These keys will help you use the program. F1- Configuration Menu This is the screen that is automatically generated when the system is first executed after it is installed. After the first time, you will only return here by request. If your RBBS system should change its file names or you should change your monitor or desire to change the date limits of the callers file analysis, you may select the configuration program to change these parameters. F2 - Analyze callers file This set of programs is the most complex to understand in the system. However, since their forunners, known as the CALL ANALYZER have been well circulated and used, this function should be familiar to most users. For those who are not familiar with it, you need simply to use it and you will become familiar with it. Many new statistics and graphs have been added. The function and control keys work totally differently. Note their definitions along the bottom of the displays. Quick Skip-Ahead One feature that is not evident, but is quite handy is what we call quick skip-ahead. You can skip forward or backwards several screens at a time by hitting the paging keys (+ or - ) several times. For instance, if you are on the callers statistics screen but desire to quickly page forward 4 screens to the baud rate graph, just hit the + (plus) key 4 time in quick succession. The system will quickly jump forward 4 screens without you having to wait for the other 3 screens to fully display. To jump back 2 screens quickly, just hit the - (minus) key 2 times in rapid succession. This feature makes movement thru the displays very easy and quick. All other functions should be obvious from the function menu along the bottom of each screen. Site Selected Statistics Many RBBS SYSOPS have modified the RBBS system to write additional information into the CALLERS file which is not standard to the CPC versions of RBBS. One such well known merge file for RBBS of this genre, is the one produced by Mark Seiden in New York. In order to accommodate these users we have provided a table of up to 19 site selected statistics that can be generated by the individual SYSOP who so desires. For a complete discussion of this table and how to generate or modify it, see Appendix A at the end of this manual. F3 - Analyze messages file This program provides many summary statistics about the current state and status of the RBBS message file. These statistics should be self explanatory. F4 - Analyze user file This program will read thru the RBBS users file and attempt to analyze, count and summarize the state in which each user resides. This is no small feat since each user may have his own way of abbreviating his state, or may not enter his city and state in a form which can easily be recognized. In those cases where a state can not be recognized as an integral part of the city state field in the RBBS users record, the system will print an error message to the system printer. Typically only about 1% of users records can not be properly handled by the Professional Analyzer. This exceptions error report can be used by the RBBS SYSOP to edit users records to make the city state field conform to a standard which the user analysis program can recognize. In addition, a state table, known as PROSTATE.TBL has been provided to allow SYSOPS to code in commonly found strings which can be recognized as belonging to one state or another. This table can be edited by the SYSOP with any text editor. On many systems, local callers might enter only a large city name such as San Francisco or Detroit without providing any state. The sysop can use this table to equate these cities or any similar character string to a specific state. See Appendix B for details and table format information. F5 - Edit users file This program provides full editing capability for any user record in the RBBS user file. Often a SYSOP needs the ability to change some field or parameter in a users record. RBBS provides some crude editing capability. However, if a SYSOP needs to edit the CITY, STATE field or needs to change some user profile parameters such as line feeds on/off or graphics on/off, RBBS provides no facilities to do this. This program works exactly like the Professional Analyzer configuration program. It is a full function editor. The user can skip from field to field by using the up or down cursor keys found on the numeric key pad. Any field can be edited except the name field, which is the file key and the last date and time on the system. To edit any user record, enter the users full name at the prompt. Professional Analyzer will then locate the record and display the data contained in it. If the record does not exist, you will receive an error message followed by a prompt for another users name. A carriage return to the prompt will terminate the editing session. To change the value in any field move the field pointer to that field and enter the changed data you desire. When you are happy with your changes, hit the ESC key. Professional Analyzer will then ask if you wish to update this record. If you do, then reply Y. An N will result in no update. CHAPTER 4 UPGRADES TO PURCHASERS This software is fully supported by Alphasoft and Micro South Systems. It is our intent to keep this software up to date with the current level of RBBS. At the time of release of this version of the Professional Analyzer, the current version of RBBS was CPC12.5B. We will provide a new release of this software with each MAJOR new version of RBBS. However, it should not be necessary to upgrade to a new release of the Professional Analyzer with each new release of RBBS. The purchaser is encouraged to stay in touch with us periodically to keep abreast of new features which might have been added to the system. A licensed purchaser of the Professional Analyzer can upgrade to any new release of the system for a $ 20 upgrade fee. Our RBBS system at (404) 761-3635 will always contain a bulletin describing the current release. All purchasers of Professional Analyzer are given free access to our RBBS. Just call the system and leave your name and the serial number of your Professional Analyzer. We will provide you with full access. We will also provide upgrade modules and/or circumventions on a person by person basis to fix any MAJOR bugs which might be discovered and reported to us. MINOR bugs will be corrected in subsequent releases. The preferred method for doing this is thru our RBBS system. We maintain a 24 hour answering service for leaving messages to report errors. The phone number is (404) 761-8137. You can generally speak to a real human being by calling this number during the weekdays after about 6 PM. This is the best time to call us if you have questions. For software that sells at such a low price, it is not possible for us to return long distance calls to you. If you wish to upgrade your release of RBBS, send your name and address and the serial number of your current version along with $20 to: AlphaSoft Systems 2508 Constance Street Atlanta, Georgia 30344 Allow 3 weeks for delivery. License Agreement Alphasoft Systems/Micro South Systems AlphaSoft Systems and Micro South systems provides these programs and licenses their use. You assume responsibility for the selection of the programs to achieve your intended results, and for the installation, use and results obtained from these programs. AlphaSoft Systems and Micro South Systems maintain full ownership of these programs. LICENSE: You may: a. Use these programs on a single machine. b. Copy these programs for purposes of backup or in support of your use of the programs on the single machine. (The programs, however, may include mechanisms to limit or inhibit copying.) YOU MAY NOT USE, COPY, MODIFY, OR TRANSFER THESE PROGRAMS OR ANY COPY, OR ANY PART OF THIS SOFTWARE SYSTEM EXCEPT AS EXPRESSLY PROVIDED FOR IN THIS LICENSE. VIOLATION OF ANY OF THE TERMS OF THIS LICENSE AUTOMATICALLY TERMINATES YOUR LICENSE. TERM: This license is effective until terminated. You agree upon termination of this license to destroy all copies of the program. LIMITED WARRANTY: These programs are provided "as is", without any warranty of any kind, either expressed or implied, including, but not limited to the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of these programs is with you. Alphasoft Systems and Micro South Systems do not warrant that the functions contained in these programs will meet your needs or that the operation of these programs will be uninterrupted or error free. Alphasoft Systems and Micro South Systems do warrant the diskette on which the programs are furnished to be free from defects of materials and workmanship for a period of ninety days from date of delivery to you as evidenced by a copy of your receipt. GENERAL: You agree that upon use of these programs you are bound by the terms and conditions of this license. APPENDIX A SITE SPECIFIED STATISTICS TABLE DEFINITION The Professional Analyzer allows a user to specify up to 19 site specific statistics to be reported. These statistics are based on searching the CALLERS file for a specific character sting and accumulating the total occurences of each character string in the CALLERS file. This will allow a user of the Professional Analyzer to modify the RBBS system to report additional utilization information in the CALLERS file. One popular RBBS merge file which provides some additional statistics is one produced my Mark Seiden. This merge to RBBS reports information about bulletins read, comments left for the SYSOP and entering and leaving of conferences. The Professional Analyzer can gather statistics on these CALLERS file entries. In order to do so, the user must specify the string which is to be searched for and the title of that statistic as it should be displayed by the Professional Analyzer. This file is called PROCALL.CTL and can be created or edited with any good text editor. The file can have up to 19 entries. The format follows "search string","title of this statistic" "search string","title of this statistic" . . . . . . . . "search string","title of this statistic" As an example lets say that you have modified RBBS to write the following message into the CALLERS file whenever a caller reads bulletin 6. Bulletin #6 read at 23:11:55 by Joe Smith To add a statistic to the Professional Analyzer for this record you would code the following entry into the PROCALL.CTL table file. "Bulletin #6 read at","Times bulletin 6 was read" The search string must be no more than 20 characters long. The displayed string can be up to 25 characters long. Strings which are longer than this will be truncated on the right. All entires after the 19th in the file will be ignored. APPENDIX B THE USER STATE SYNONYM DEFINITION TABLE The state synonym table allows the user of the Professional Analyzer to equate certain character strings with a specific state. For instance, many users call an RBBS system and enter only a city in the RBBS city and state field. The Professional Analyzer extract program cannot differentiate between a state and city except by the presence of a comma (,) or by selecting the last "word" in the city state field. In this instances, what the Professional Analyzer assumes to be a state is incorrect. It is a city. In order to make the program equate certain cities (or any character string) to certain states, we have provided a synonym table that is editable by the Professional Analyzer user. Any text editor can be used for the purpose of editing this table. The format follows: XX/AAAAAAAAAAAAAAA/BBBBBBBBBBBBBBBBBBB/CCCCCCCCCC/DDDD/EEEE where XX = A state abbreviation. NOTE: THIS 2 BYTE PORTION OF THE FIELD IS THE STRING TO WHICH ALL OTHERS ARE BEING EQUATED. FOR THIS REASON, THE FIRST 2 BYTE FIELD SHOULD NEVER BE EDITED. AAAAAAAAAAAAAAA = any string BBBBBBBBBBBBBBBBBB = any string CCCCCCCCCCCCC = any string DDDD = any string EEEE = any string As an example: MA/MASSACHUSETTS/BOSTON/CAMBRIDGE/SALEM/ Up to 5 strings may follow the 2 character abbreviation. The table that is provided with the system already equates the correct full spelling of each state with its abbreviation. It is the users responsibility to add up to 4 additional equates as needed. This feature should be used sparingly as it is limited by the additional 4 fields. It is best to edit single RBBS USERS records to conform to the standard city followed by a comma followed by a 2 character abbreviation than to try and accommodate a few odd USERS records. This feature should be used only when the SYSOP recognizes a common trend that many users repeatedly enter such as a city only entry. Ordering Information: To order send $ 49.00 + 3.00 handling and shipping to: AlphaSoft Systems 2508 Constance Street Atlanta, Georiga 30344 Allow 10 days for delivery. 15 day money back gaurantee if unsatified.